file_path stringlengths 5 148 | content stringlengths 150 498k | size int64 150 498k |
|---|---|---|
1_0_0_48.md | # 1.00.48
**Release Date:** Feb 2021
## New Features
- News tab – shows the latest information about Omniverse
- Show Nucleus Web on the collaboration tab
- Improved keyboard navigation and accessibility
- Update info for installed apps and connectors automatically when the library tab is opened
- Improved the drag ar... | 1,821 |
1_0_42.md | # 1.0.42
**Release Date:** Jan 2021
> - Added News section to display content from Omniverse News in the launcher
> - Fixed collecting hardware info on Linux when lshw returns an array
> - Add a login session in System Monitor when Nucleus is installed
> - Moved all licenses to PACKAGE-LICENSES folder, added a LICENSE... | 416 |
1_0_50.md | # 1.0.50
**Release Date:** March 2021
## Fixed
- Catch unexpected Starfleet responses and return the error that tells users to log in.
- Fixed licenses link not working on Linux.
## Removed
- Remove debug noise in logs from the auto-updater. | 243 |
1_1_2.md | # 1.1.2
**Release Date:** March 2021
## Spotlight Features
New “Learn Tab” available in launcher lets you get quick and immediate “in-launcher” access to our video learning portal. From Introductory content for the beginner to highly focused deep dives for the experienced, Omniverse Learning Videos are now just a clic... | 2,602 |
1_2_8.md | # 1.2.8
**Release Date:** Aug 2021
## Spotlight Features
**Previous Versions**
Users can now install previous version of Omniverse via a new and improved interface.
Easy Links
When opening files for the first time from a linked location, launcher now confirms the app to load with.
Users can also set the default app ... | 3,810 |
1_3_3.md | # 1.3.3
## Added
- Added the OS version to com.nvidia.omniverse.launcher.session telemetry event.
- Added the locale to com.nvidia.omniverse.launcher.session telemetry event.
- Added “Developer” and “Publisher” fields to component details.
- Show “Welcome to Omniverse” page on the first launch.
- Support installing the... | 1,230 |
1_3_4.md | # 1.3.4
## Added
- Show the installation date for apps displayed on the library tab.
- Added “Collect debug info” button to the settings dialog to prepare a tarball with logs and configuration files.
- Show “External link” button for third-party components on the detailed page.
## Fixed
- Fixed an issue where links on... | 536 |
1_4_0.md | # 1.4.0
**Release Date:** Nov 2022
## Changed
- Added retries for downloading EULA and GDPR agreements.
## Fixed
- Fixed an issue with scrolling the left menu on the exchange tab.
- Fixed an issue where Launcher dialogs were displayed behind the exchange view after navigation.
- Fixed an issue where thin packages cou... | 763 |
1_5_1.md | # 1.5.1
## Added
- Launcher can now pull notifications from the server. This can be used to send important messages to users instead of displaying them in the toolbar.
## Changed
- Changed colors for messages displayed in the bottom toolbar (white for regular text and blue for links instead of yellow).
## Fixed
- Esc... | 824 |
1_5_3.md | # 1.5.3
**Release Date:** March 2022
## Added
- Added a `check` argument for `omniverse-launcher://install` command that manages throwing an error in case the same component is already installed.
- Support external links for third-party content.
## Fixed
- Fixed an issue where downloaded zip archives were not removed... | 532 |
1_5_4.md | # 1.5.4
## Fixed
- Fixed an issue where users couldn’t change configured paths in Launcher.
- Fixed Italian translations.
- Fixed an issue where Launcher couldn’t be started if System Monitor is installed but missing on disk.
- Fixed an issue where connector updates were started immediately instead of being queued on t... | 431 |
1_5_5.md | # 1.5.5
**Release Date:** June 2022
## Fixed
- Fixed an issue related to refreshing the session when installing new apps after desktop comes out of sleep mode.
- Fixed an issue where connectors displayed in the library were enlarged.
- Fixed an issue related to a blank error when Launcher is started without internet c... | 518 |
1_5_7.md | # 1.5.7
## Added
- Added new controls for changing the current language on the login screen.
- Added the Extensions content type in the Exchange.
## Fixed
- Fixed an issue where the close icon closed Launcher instead of hiding it to the system tray.
- Removed the crash reporter logging when using custom protocol comma... | 578 |
1_6_1.md | # 1.6.10
**Release Date:** Sept 2022
## Added
- Integrated Navigator filesystem directly into the Nucleus tab.
- Added “Show in folder” option for downloaded files in Navigator.
- Extension installation.
- /open command for opening files with installed applications.
- Added links for Nucleus Cache in the library.
- Di... | 1,295 |
1_7_1.md | # 1.7.1
## Added
- Renamed Enterprise Launcher to IT Managed Launcher.
- Added new UI elements on Exchange cards to filter releases by release channel. A release is classified as Alpha, Beta, Release, or Enterprise, depending on its maturity and stability. If an Alpha or Beta release is selected, a banner appears on th... | 718 |
1_8_11.md | # 1.8.11
**Release Date:** July 2023
## Changed
- Updated Nucleus tab with Navigator 3.3.2.
- Display “Install” button for new versions in the setting menu on the Library tab.
- Extend omniverse-launcher://launch command to support custom launch scripts.
## Fixed
- Fixed an issue where users were unable to exit from ... | 792 |
1_8_2.md | # 1.8.2
**Release Date:** Dec 2022
## Added
- Added new UI elements on Exchange cards to filter releases by release channel. A release is classified as Alpha, Beta, Release, or Enterprise, depending on its maturity and stability. If an Alpha or Beta release is selected, a banner appears on the main image to emphasize ... | 713 |
1_8_7.md | # 1.8.7
## Added
- Show Nucleus update version on the Nucleus tab.
- Added a Data Opt-In checkbox allowing users to opt-in and opt-out of data collection.
- Display Cache version in the library.
## Fixed
- Updated Nucleus tab with Navigator 3.3. | 246 |
1_9_10.md | # 1.9.10
**Release Date:** Jan 2024
## Added
- Anonymize telemetry events when users opt out of data collection.
- Support feature targeting by OS, Launcher version, build or user profile.
- Update Nucleus Navigator to 3.3.4.
- Support silent launch for custom protocol commands.
## Changed
- Enabled “Newest” sorting ... | 1,809 |
1_9_11.md | # 1.9.11
**Release Date:** April 2024
## Fixed
- Fixed an issue where Launcher was minimized to the system tray instead of exiting when users clicked on Exit option in user settings menu.
- Fixed a race condition that could cause settings reset. [OM-118568]
- Fixed gallery positioning for content packs. [OM-118695]
- ... | 1,263 |
1_9_8.md | # 1.9.8
## Added
- Featured Collections section added to the Exchange tab.
- Collection Side Nav expanded by default in Exchange tab.
- Pass proxy settings to launched applications with OMNI_PROXY_SERVER environment variable.
- Add custom UI for Omniverse Hub app.
- Add window titles for News and Learn tabs.
- Block us... | 3,576 |
a-simple-extension-demonstrating-how-to-bundle-an-external-renderer-into-a-kit-extension_Overview.md | # Overview
## A simple extension demonstrating how to bundle an external renderer into a Kit extension.
### extension.toml: Important keys
- **order = -100**
- # Load the extension early in startup (before Open USD libraries)
- **writeTarget.usd = true**
- # Publish the extension with the version of Open USD built ... | 770 |
a-third-way-to-add-an-extension_overview.md | # Omniverse Kit Project Template
## Omniverse Kit Project Template
This project is a template for developing apps and extensions for *Omniverse Kit*.
## Important Links
- Omniverse Documentation Site
- Github Repo for this Project Template
- Extension System
## Getting Started
1. Fork/Clone the Kit Project Template ... | 8,876 |
ABI.md | # ABI Compatibility
## Importance
Each C/C++ source file (compilation unit) is processed by the compiler to form an object file. These object files are then combined together by a linker to form a binary (executable, static library, dynamic library, etc.). All of these items–object files, executables, static/dynamic ... | 22,441 |
about_Overview.md | # Overview
CAD Converter Service Extension - [omni.services.convert.cad]
## About
The CAD Converter Service is a service for batch conversion of CAD files to USD.
## SAMPLE REQUEST:
**Format**: “setting name” : default value
Request arguments:
```json
{
"import_path": ""
}
```
Full path to the CAD File to convert.... | 1,017 |
action-registry_Overview.md | # Overview — Omniverse Kit 1.0.0 documentation
## Overview
The Omni Kit Actions Core extension is a framework for creating, registering, and discovering actions. Actions are programmable objects that can encapsulate anything which occurs in a fire and forget manner. An action can be created in one extension and then e... | 1,631 |
ActionGraph.md | # Action Graph
This extension is a collection of functionality required for OmniGraph Action Graphs.
- [Hands-on Introduction to Action Graphs](https://docs.omniverse.nvidia.com/app_code/prod_extensions/ext_omnigraph/tutorials/quickstart.html)
- [Action Graph Car Customizer Tutorial](https://docs.omniverse.nvidia.com... | 4,990 |
actions_Overview.md | # Overview
## Overview
The Omni Kit Actions Core extension is a framework for creating, registering, and discovering actions. Actions are programmable objects that can encapsulate anything which occurs in a fire and forget manner. An action can be created in one extension and then executed from anywhere else in the ap... | 2,058 |
action_code_samples_cpp.md | # Action Code Samples - C++
This file contains a collection of examples for implementing OGN nodes that work in Action Graphs. The features that are particular to Action Graph are accessed in C++ through the `IActionGraph` interface. All the concepts of OmniGraph apply equally to Action Graph nodes. See [OGN User Guid... | 6,404 |
action_code_samples_python.md | # Action Graph Code Samples - Python
This file contains a collection of examples for implementing OGN nodes that work in Action Graphs. The features that are particular to Action Graph are accessed with `<omni.graph.action.IActionGraph>`. All the concepts of OmniGraph apply equally to Action Graph nodes. See [OGN User... | 6,195 |
activities-tab_Overview.md | # Overview
omni.activity.ui is an extension created to display progress and activities. This is the new generation of the activity monitor which replaces the old version of omni.kit.activity.widget.monitor extension since the old activity monitor has limited information on activities and doesn’t always provide accurat... | 5,966 |
activity-timeline-window_Overview.md | # Overview
## Activity Progress Window
### Progress Bar Tab
### Activity Tab
## Activity Timeline Window
### Timeline Tab
## Timeline Tab
Users can double click to see what’s happening in each activity, double click with shift will expand/collapse all.
Right mouse move can pan the timeline view vertically and ho... | 2,525 |
add-extensions_app_from_scratch.md | # Develop a Simple App
This section provides an introduction to Application development and presents important foundational knowledge:
- How Applications and Extensions are defined in `.kit` and `.toml` files.
- How to explore existing Extensions and adding them to your Application.
- How user settings can override A... | 14,185 |
add-language-from-kit-file_OVERVIEW.md | # Overview
## Omniverse Language & Font extension [omni.kit.language.core]
This extension has support for changing font.
```python
omni.kit.language.core.register_language(("ja_JP", "Japanese", "日本語"),
f"{extension_path}/data/fonts/NotoSansJP-SemiBold.ttf",
... | 1,874 |
add-menu_Overview.md | # Overview
This is the context menu used in stage and viewport windows. For documentation on creating/adding to context menu, see documentation for omni.kit.widget.context_menu. Functions supported are;
## get_widget_instance
Get instance of omni.kit.widget.context_menu class
## get_instance
Get instance of contex... | 886 |
add-to-add-menu_Overview.md | # Overview — Omniverse Kit 1.2.0 documentation
## Overview
This is the low level context menu that drives omni.kit.context_menu and other extensions. This is a widget.
### Implement a context menu in window
```python
import omni.ui as ui
import omni.usd
import omni.kit.widget.context_menu
from omni.kit.widget.context... | 5,618 |
add-to-the-primpathwidget_Overview.md | # Overview — Omniverse Kit 1.11.1 documentation
## Overview
The omni.kit.window.property extension offers a window that displays properties and enables users to modify them. Additional features such as property filtering for convenient searching are included as well as convenience functions to add new properties.
USD-... | 12,364 |
add-world-bonds_ext_assetutils.md | # Asset Utilities (NvBlastExtAssetUtils)
NvBlastExtAssetUtils provides simple utility functions for modifying NvBlastAsset objects. Three functions are provided, described in the following sections.
## Add World Bonds
The function NvBlastExtAssetUtilsAddWorldBonds allows the user to create an asset from an existing ... | 4,636 |
adding-a-menu-for-your-extension_Overview.md | # Overview
## Overview
omni.kit.menu.utils allows users to add/remove/update menus for the top bar of the window.
## Adding a menu for your extension
What does this do?
- Adds a menu item “Menu Example” in “File” menu using icon file.svg and when clicked executes action “omni.kit.menuext.extension” / “menu_example”.
... | 3,910 |
adding-preferences-to-your-extension_Overview.md | # Overview — Omniverse Kit 1.5.1 documentation
## Overview
omni.kit.window.preferences has a window where users customize settings.
NOTE: This document is going to refer to pages, a page is a `PreferenceBuilder` subclass and has name and builds UI. See `MyExtension` below
## Adding preferences to your extension
To c... | 6,276 |
adding-widgets-to-your-ui_Overview.md | # Overview — Omniverse Kit 1.1.2 documentation
## Overview
omni.kit.widget.settings has a library of widget functions that access values via settings, used by:
- omni.kit.property.transform
- omni.kit.viewport.menubar.core
- omni.kit.window.extensions
- omni.kit.window.preferences
- omni.rtx.window.settings
## Adding... | 4,520 |
aliases_index.md | # Omniverse Client Library
## Documentation
The latest documentation can be found at [omniverse-docs.s3-website-us-east-1.amazonaws.com/client_library/](http://omniverse-docs.s3-website-us-east-1.amazonaws.com/client_library/)
## Samples
The Omniverse Connect sample is available through the Omniverse Launcher.
Docum... | 9,055 |
allocator_api_globals_users_guide.md | # Globals API (NvBlastGlobals)
The NvBlastGlobals library is a utility library which is used by NvBlastTk (see High Level (Toolkit) API (NvBlastTk)) and some extensions (see Extensions (NvBlastExt)) and samples.
It provides a global allocator, error callback, and profiler API.
## Allocator
**Include NvBlastGlobals.... | 2,035 |
animation_index.md | # omni.kit.usd_docs: Omni USD Documentation
## USD in Kit
### FAQ
Q: Does Kit (and Omniverse) use Vanilla USD?
The short answer is no - we have some custom modifications which mean our version of USD “nv_usd” is partially ABI incompatible with a standard build of USD. Many of these changes are in Hydra and Asset Re... | 22,511 |
anonymous-data-mode_KitTelemetry.md | # Configuring the `omni.kit.telemetry` Extension
## Overview
The `omni.kit.telemetry` extension is responsible for a few major tasks. These largely occur in the background and require no direct interaction from the rest of the app. All of this behavior occurs during the startup of the extension automatically. The maj... | 21,521 |
api-and-changelog_index.md | # Omni Asset Validator (UI)
Kit UIs for validating assets against Omniverse specific rules to ensure they run smoothly across Omniverse products.
It includes the following components:
- An **Asset Validator Window** to select rules and run validation on individual USD layer files, recursively search a folder for layer... | 10,723 |
api-changes_Overview.md | # Overview
## Introduction
The Omni USD extension (`omni.usd`) is the Python frontend of `omni.usd.core`. It serves to load and initialize Pixar USD library, and Omniverse USD Resolver that supports opening USD from Omniverse/HTTP urls. It provides synchronous and asynchronous interfaces in C++ and Python to manage `om... | 9,417 |
api-contents_blast-sdk_api.md | # blast-sdk-5.0.4
## Directory hierarchy
- **dir extensions**
- **extensions/assetutils**
- **extensions/assetutils/NvBlastExtAssetUtils.h**
- **extensions/authoring**
- **extensions/authoring/NvBlastExtAuthoring.h**
- **extensions/authoring/NvBlastExtAuthoringBondGenerator.h**
### File List
- **file*... | 5,553 |
api-documentation_Overview.md | # Overview
This extension enables support for changing scene wide wetness parameters and enable runtime puddle placement on Drivesim.
## Attention
This extension is not related to the SimReady Enviroment System UI. Both can coexist and will be merged at some point.
## API documentation
Refer to
- [omni::avreality... | 8,708 |
API.md | # API (python)
## Module Summary:
| Module | Description |
|--------|-------------|
| omni.example.cpp.ui_widget | omni.example.cpp.ui_widget |
## Module Details:
omni.example.cpp.ui_widget:
## omni.example.cpp.ui_widget | 225 |
api_hl_users_guide.md | # High Level (Toolkit) API (NvBlastTk)
## Table of Contents
- [Introduction to NvBlastTk](#tkintroduction)
- [NvBlastTk Class Hierarchy](#tk-class-hierarchy)
- [Linking and Header Files](#tk-include-and-library)
- [Creating the TkFramework](#framework-init)
- [Creating a TkAsset](#tkasset-creation)
- [Instancing a Tk... | 31,945 |
api_ll_users_guide.md | # Low Level API (NvBlast)
## Introduction
The low-level API is the core of Blast destruction. It is designed to be a minimal API that allows an experienced user to incorporate destruction into their application. Summarizing what the low-level API has, and doesn’t have:
- There is no physics representation. The low-l... | 19,519 |
application-dependencies-management_creating_kit_apps.md | # Building an App
## Simple App
Here is an example of a very simple app with a dependency and setting applied: `repl.kit`:
```toml
[dependencies]
"omni.kit.console" = {}
[settings]
exts."omni.kit.console".autoRunREPL = true
```
Pass the `repl.kit` file to the `Kit` executable:
```
> kit.exe repl.kit
```
and it will... | 12,437 |
application-id_Overview.md | # GDN Asset Publisher [omni.gdn_asset_publisher]
The GDN asset publisher collects the chosen asset, zips it, and then uploads it to GDN.
## Asset Path:
The path to the stage. By default when the extension is loaded it uses the currently opened stage, but you can click the browse button to browse to any other stage. Yo... | 948 |
apps.md | # Example Apps
## Simple App Window: `my_name.my_app.kit`
The simple application showcases how to create a very basic Kit-based application showing a simple window.
It leverages the kit compatibility mode for the UI that enables it to run on virtually any computer with a GPU.
It uses the window extension example tha... | 1,447 |
Ar.md | # Ar module
Summary: The Ar (Asset Resolution) library is responsible for querying, reading, and writing asset data.
## Classes:
- **DefaultResolver**
- Default asset resolution implementation used when no plugin implementation is provided.
- **DefaultResolverContext**
- Resolver context object that specifies a... | 16,077 |
architecture-pillars_index.md | # Execution Framework
The Omniverse ecosystem enjoys a bevy of software components (e.g. PhysX, RTX, USD, OmniGraph, etc). These software components can be assembled together to form domain specific applications and services. One of the powerful concepts of the Omniverse ecosystem is that the assembly of these compone... | 7,241 |
Architecture.md | # Architecture
## Architectural Principles
A few important architectural principles guide the design of the software and have been captured here. It’s important you know these principles since they will help you understand our design decisions and guide you when faced with design trade-offs.
### Customer first
*The... | 31,450 |
Asserts.md | # Carbonite Asserts
## Overview
The assertion framework in Carbonite is designed to be usable for a variety of situations, extensible, and performant.
At its core, an assertion framework allows logging a message and/or stopping in the debugger if an unexpected situation occurs. This allows a programmer to intervene ... | 18,265 |
asset-structure_introduction.md | # Introduction
Blast is an NVIDIA GameWorks Blast destruction library. It consists of a Low Level API (NvBlast), a High Level (Toolkit) API (NvBlastTk) (Blast Toolkit or BlastTk), and Extensions (NvBlastExt) (Blast Extensions or BlastExt). This layered API is designed to allow short ramp-up time for first usage (throu... | 5,645 |
AttributeType.md | # Attribute Type Definition
Attributes in OmniGraph all have a type, which indicates what kind of data they can represent. The type definitions are attached to the attributes so that their associated data can be correctly stored and interpreted.
In addition, the type definition can be used to disambiguate values that... | 19,519 |
attribute_types.md | # Attribute Data Types
The attribute data type is the most important part of the attribute. It describes the type of data the attribute references, and the type of generated interface the node writer will use to access that data.
Attribute data at its core consists of a short list of data types, called [Base Data Typ... | 56,725 |
auto-authoring_Overview.md | # Overview — Omniverse Kit 2.1.34 documentation
## Overview
**Extension** : omni.kit.usd.layers-2.1.34
**Documentation Generated** : May 08, 2024
### Overview
Layer is the atomic persistent storage for USD. Extension `omni.kit.usd.layers` is built on top of USD that serves to provide utilities and workflows around... | 18,545 |
basic-principle_Overview.md | # Overview
Nucleus registry implementation for extension system.
It is important for such extension to be enabled as soon as possible so that other extensions can use it as a bootstrap to be downloaded. Once enabled it registers itself in the extension manager as extension registry provider.
## Settings
Refer to `e... | 642 |
batch-position-helper_overview.md | # Overview
Omni.kit.widget.graph provides the base for the delegate of graph nodes. It also defines the standard interface for graph models. With the layout algorithm, GraphView gives a visualization layer of how graph nodes display and how they connect/disconnect with each to form a graph.
## Delegate
The graph node’... | 2,813 |
BestPractices.md | # Best Practices
This is a collection of best practices we recommend for making development with OmniGraph consistent and easy. Although there is certainly more than one way of accomplishing many goals, we believe that there is value in following a set of core guidelines. It not only helps keep your own code simple, i... | 589 |
bindings_Overview.md | # Overview
This is the gold standard template for creating a Kit extension that contains a mixture of Python and C++ OmniGraph nodes.
## The Files
To use this template first copy the entire directory into a location that is visible to your build, such as `source/extensions`. The copy will have this directory structu... | 22,702 |
blast-sdk-documentation_index.md | # Blast SDK Documentation
Blast is a NVIDIA Omniverse destruction library. It consists of three layers: the low-level (NvBlast), a high-level “toolkit” wrapper (NvBlastTk), and extensions (prefixed with NvBlastExt). This layered API is designed to allow short ramp-up time for first usage (through the Ext and Tk APIs) ... | 7,551 |
bondgenerator_ext_authoring.md | # Asset Authoring (NvBlastExtAuthoring)
The Authoring extension provides tools for creation of a Blast asset from a provided mesh.
There are four tools for creation of Blast assets.
## FractureTool
Nv::Blast::FractureTool (see NvBlastExtAuthoringFractureTool.h) is used to fracture an input mesh. It supports Voronoi... | 3,831 |
boost_copyrights.md | # Copyrights
## Boost
Blast [Asset Authoring (NvBlastExtAuthoring)](extensions/ext_authoring.html#pageextauthoring) uses Boost (boost.org). This is licensed as follows.
```
Boost Software License - Version 1.0 - August 17th, 2003
Permission is hereby granted, free of charge, to any person or organization
obtaining a... | 3,157 |
build.md | # Build a Project
Depending on the nature of your project, a ‘build step’ may be required as development progresses. Omniverse supports this step with a variety of scripts and tools that generate a representation of the final product, enabling subsequent testing, debugging, and packaging.
## Build-less Projects
Pyth... | 1,857 |
Building.md | # Building Carbonite
## Building Source
To build on Windows:
```bash
# build both release and debug
build
# debug build
build -d
# release build
build -r
# clean build output
build -c
```
The commands above also work on Linux, though `build` should be replaced with `./build.sh`.
```c++
./build.sh
```
Output from t... | 2,859 |
building_index.md | # Omniverse Carbonite SDK
The Omniverse Carbonite SDK is the foundational software layer for Omniverse applications, microservices, tools, plugins, Connectors, and SDKs.
The Omniverse Carbonite SDK provides the following high-level features:
## ABI Stable Interfaces
The core of Carbonite provides tooling that enabl... | 2,761 |
build_tools.md | # Build Tools
## Packman
The basic package management tool used on OV, see packman. A copy of the currently used packman lives in tools/packman in most repositories. It can be easily upgraded to newer versions.
## Repo Tools “RepoMan”
These are a set of small utility libraries whose source lives in https://gitlab-mas... | 6,394 |
Bundles.md | # Bundles User Guide
## Introduction
Prior to the `1.59.0` version, the following nodes: `Read Prim` and `Read Prim into Bundle` used to read `UsdPrim`s from a `UsdStage` as a single primitive in a bundle. Meaning, the attributes of the primitive were saved directly in the output bundle. As a consequence, `Read Prim*... | 4,250 |
buttons.md | # Buttons and Images
## Common Styling for Buttons and Images
Here is a list of common style you can customize on Buttons and Images:
> border_color (color): the border color if the button or image background has a border
> border_radius (float): the border radius if the user wants to round the button or image
> b... | 25,990 |
c-support_Overview.md | # Overview
## Overview
### Extension
: omni.kit.commands-1.4.9
### Documentation Generated
: May 08, 2024
Commands and Undo/Redo system.
A **Command** is an undo/redo system primitive. It is a class which gets instantiated and the `do` method is called on an instance. The instance is stored in the undo stack if it... | 4,130 |
c-usage-examples_Overview.md | # Overview — Kit Extension Template C++ 1.0.0 documentation
## Overview
An example C++ extension that can be used as a reference/template for creating new extensions.
Demonstrates how to create a C++ object that will startup / shutdown along with the extension.
## C++ Usage Examples
### Defining Extensions
```c++
/... | 1,641 |
cad-converter-config-file-inputs_Overview.md | # Overview
omni.kit.converter.hoops_core uses the HOOPS Exchange SDK to convert a variety of CAD data formats to USD.
When this extension loads, it will register itself with the CAD Converter service (omni.services.convert.cad) if it is available.
## CAD CONVERTER CONFIG FILE INPUTS:
Conversion options are configur... | 2,893 |
cad-converter_Overview.md | # CAD Converter
## Overview
The CAD Converter extension enables conversion for many common CAD file formats to USD.
USD Explorer includes the CAD Converter extension enabled by default.
## Supported CAD file formats
The following file formats are supported by CAD Converter:
- CATIA V5 Files (`*.CATPart, *.CATProduc... | 2,555 |
camera-manipulator_Overview.md | # Camera Manipulator — Omniverse Kit 105.0.5 documentation
## Camera Manipulator
Mouse interaction with the Viewport is handled with classes from `omni.kit.manipulator.camera`, which is built on top of the `omni.ui.scene` framework.
We’ve created an `omni.ui.scene.SceneView` to host the manipulator, and by simply assi... | 6,706 |
CameraUtil.md | # CameraUtil module
Summary: Camera Utilities
## Module: pxr.CameraUtil
Camera utilities.
### Classes:
| Class | Description |
|-------|-------------|
| ConformWindowPolicy | |
| Framing | Framing information. |
| ScreenWindowParameters | Given a camera object, compute parameters suitable for setting up RenderMan. ... | 4,768 |
capture.md | # Capture
[](#capture)
`omni.kit.widget.viewport.capture` is the interface to a capture a Viewport’s state and AOVs.
It provides a few convenient implementations that will write AOV(s) to disk or pass CPU buffers for pixel access.
## FileCapture
[](#filecapture)
A simple delegate to capture a single AOV to a singl... | 3,261 |
carb-license_LicenseInfo.md | # License
Copyright (c) 2020-2023, NVIDIA CORPORATION. All rights reserved.
NVIDIA CORPORATION and its licensors retain all intellectual property
and proprietary rights in and to this software, related documentation
and any modifications thereto. Any use, reproduction, disclosure or
distribution of this software and ... | 426 |
carb-testing_Testing.md | # Testing
Testing is one of the cornerstones of Carbonite philosophy. Our goal is to keep all the plugins and the framework itself covered with tests and continuously run them on every MR. The isolated nature of the plugin interfaces makes unit testing easy and straightforward. This guide describes how to write new te... | 4,235 |
carb.settings.acquire_settings_interface.md | # acquire_settings_interface
## acquire_settings_interface
### `carb.settings.acquire_settings_interface(plugin_name: str = None, library_path: str = None) -> carb.settings._settings.ISettings`
- **Parameters**:
- `plugin_name`: str, optional
- `library_path`: str, optional
- **Returns**:
- `carb.settings._set... | 336 |
carb.settings.ChangeEventType.md | # ChangeEventType
## ChangeEventType
```python
class carb.settings.ChangeEventType
```
**Bases:**
```python
pybind11_object
```
**Members:**
- CREATED: An Item was created
- CHANGED: An Item was changed
- DESTROYED: An Item was destroyed
**Methods**
| Method | Description |
|--------|-------------|
| `__init__(sel... | 740 |
carb.settings.Classes.md | # carb.settings Classes
## Classes Summary
| Class | Description |
|-------|-------------|
| [ChangeEventType](#) | Members: |
| [ISettings](#) | The Carbonite Settings interface |
| [SubscriptionId](#) | Representation of a subscription | | 241 |
carb.settings.Functions.md | # carb.settings Functions
## Functions Summary
- **get_settings**
- Returns cached :class:`carb.settings.ISettings` interface (shorthand).
- **lru_cache**
- Least-recently-used cache decorator.
- **acquire_settings_interface**
- acquire_settings_interface(plugin_name: str = None, library_path: str = None) -> ... | 353 |
carb.settings.ISettings.md | # ISettings
## ISettings
- **Bases:** `pybind11_object`
- **Description:** The Carbonite Settings interface. Carbonite settings are built on top of the carb.dictionary interface. Many dictionary functions are replicated in settings, but explicitly use the settings database instead of a generic carb.dictionary.Item obj... | 16,063 |
carb.settings.lru_cache.md | # lru_cache
## lru_cache
```python
carb.settings.lru_cache(maxsize=128, typed=False)
```
Least-recently-used cache decorator.
If `maxsize` is set to None, the LRU features are disabled and the cache can grow without bound.
If `typed` is True, arguments of different types will be cached separately. For example, f(3.0... | 755 |
carb.settings.md | # carb.settings
## Classes
Summary:
| Class | Description |
|-------|-------------|
| ChangeEventType | Members: |
| ISettings | The Carbonite Settings interface |
| SubscriptionId | Representation of a subscription |
## Functions
Summary:
| Function | Description |
|----------|-------------|
| get_settings | Retur... | 588 |
carb.settings.SubscriptionId.md | # SubscriptionId
## SubscriptionId
```python
class carb.settings.SubscriptionId
```
Representation of a subscription
### Methods
| Method | Description |
|--------|-------------|
| `__init__(*args, **kwargs)` | |
```python
def __init__(*args, **kwargs):
pass
--- | 273 |
carb.tokens.Functions.md | # carb.tokens Functions
## Functions Summary:
- **get_tokens_interface**
- Returns cached :class:`carb.tokens.ITokens` interface
- **acquire_tokens_interface**
- acquire_tokens_interface(plugin_name: str = None, library_path: str = None) -> carb.tokens._tokens.ITokens | 275 |
carb.tokens.get_tokens_interface.md | # get_tokens_interface
## get_tokens_interface
### carb.tokens.get_tokens_interface
#### Returns
- `ITokens`: [carb.tokens.ITokens](carb.tokens.ITokens.html#carb.tokens.ITokens)
#### Description
Returns cached `carb.tokens.ITokens` interface | 251 |
carb.tokens.ITokens.md | # ITokens
## ITokens
```
class carb.tokens.ITokens
```
**Bases:**
```
pybind11_object
```
**Methods:**
| Method | Description |
|--------|-------------|
| `__init__(*args, **kwargs)` | |
| `exists(self, arg0)` | |
| `remove_token(self, arg0)` | |
| `resolve(self, str[, flags])` | |
| `set_initial_value(self, a... | 915 |
carb.tokens.md | # carb.tokens
## Classes Summary
- [ITokens](./carb.tokens.Classes.html)
## Functions Summary
- [get_tokens_interface](carb.tokens/carb.tokens.get_tokens_interface.html)
- Returns cached :class:`carb.tokens.ITokens` interface
- [acquire_tokens_interface](carb.tokens/carb.tokens.acquire_tokens_interface.html)
- ac... | 424 |
CarboniteInterfaces.md | # Creating a New Carbonite Interface
## Overview
Carbonite interfaces are simple yet powerful when used appropriately. There are a few considerations to be made when choosing to make a Carbonite interface versus an ONI one. Carbonite interfaces are best used in situations where global data or state can be used or whe... | 29,852 |
carbonite_api.md | # Carbonite SDK API
## Directory hierarchy
- **dir**
- **carb**
- **carb/assert**
- **AssertUtils.h**
- **IAssert.h**
- **carb/assets**
- **AssetsTypes.h**
- **AssetsUtils.h**
### carb/assets
- file carb/assets/AssetsUtils.h
- file carb/assets/IAssets.h
- file carb/assets/IAssetsBlob... | 39,982 |
carbonite_kit_overview.md | # Overview
## Omniverse Kit
**Omniverse Kit** is the SDK for building **Omniverse** applications like **Create** and **View**. It can also be used to develop your own **Omniverse** applications.
It brings together a few major components:
- USD/Hydra (see also omni.usd)
- Omniverse (via Omniverse client library)
- Carb... | 4,737 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.